<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Voro++: config.hh Source File</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />



</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Voro++
   
   </div>
   
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript" src="dynsections.js"></script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </div>
<div class="header">
  <div class="headertitle">
<div class="title">config.hh</div>  </div>
</div>
<div class="contents">
<a href="config_8hh.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">// Voro++, a 3D cell-based Voronoi library</span>
<a name="l00002"></a>00002 <span class="comment">//</span>
<a name="l00003"></a>00003 <span class="comment">// Author   : Chris H. Rycroft (LBL / UC Berkeley)</span>
<a name="l00004"></a>00004 <span class="comment">// Email    : chr@alum.mit.edu</span>
<a name="l00005"></a>00005 <span class="comment">// Date     : August 30th 2011</span>
<a name="l00006"></a>00006 <span class="comment"></span>
<a name="l00007"></a>00007 <span class="comment">/** \file config.hh</span>
<a name="l00008"></a>00008 <span class="comment"> * \brief Master configuration file for setting various compile-time options. */</span>
<a name="l00009"></a>00009 
<a name="l00010"></a>00010 <span class="preprocessor">#ifndef VOROPP_CONFIG_HH</span>
<a name="l00011"></a>00011 <span class="preprocessor"></span><span class="preprocessor">#define VOROPP_CONFIG_HH</span>
<a name="l00012"></a>00012 <span class="preprocessor"></span>
<a name="l00013"></a>00013 <span class="keyword">namespace </span>voro {
<a name="l00014"></a>00014 
<a name="l00015"></a>00015 <span class="comment">// These constants set the initial memory allocation for the Voronoi cell</span><span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">/** The initial memory allocation for the number of vertices. */</span>
<a name="l00017"></a>00017 <span class="keyword">const</span> <span class="keywordtype">int</span> init_vertices=256;<span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment">/** The initial memory allocation for the maximum vertex order. */</span>
<a name="l00019"></a>00019 <span class="keyword">const</span> <span class="keywordtype">int</span> init_vertex_order=64;<span class="comment"></span>
<a name="l00020"></a>00020 <span class="comment">/** The initial memory allocation for the number of regular vertices of order</span>
<a name="l00021"></a>00021 <span class="comment"> * 3. */</span>
<a name="l00022"></a>00022 <span class="keyword">const</span> <span class="keywordtype">int</span> init_3_vertices=256;<span class="comment"></span>
<a name="l00023"></a>00023 <span class="comment">/** The initial memory allocation for the number of vertices of higher order.</span>
<a name="l00024"></a>00024 <span class="comment"> */</span>
<a name="l00025"></a>00025 <span class="keyword">const</span> <span class="keywordtype">int</span> init_n_vertices=8;<span class="comment"></span>
<a name="l00026"></a>00026 <span class="comment">/** The initial buffer size for marginal cases used by the suretest class. */</span>
<a name="l00027"></a>00027 <span class="keyword">const</span> <span class="keywordtype">int</span> init_marginal=64;<span class="comment"></span>
<a name="l00028"></a>00028 <span class="comment">/** The initial size for the delete stack. */</span>
<a name="l00029"></a>00029 <span class="keyword">const</span> <span class="keywordtype">int</span> init_delete_size=256;<span class="comment"></span>
<a name="l00030"></a>00030 <span class="comment">/** The initial size for the auxiliary delete stack. */</span>
<a name="l00031"></a>00031 <span class="keyword">const</span> <span class="keywordtype">int</span> init_delete2_size=256;<span class="comment"></span>
<a name="l00032"></a>00032 <span class="comment">/** The initial size for the wall pointer array. */</span>
<a name="l00033"></a>00033 <span class="keyword">const</span> <span class="keywordtype">int</span> init_wall_size=32;<span class="comment"></span>
<a name="l00034"></a>00034 <span class="comment">/** The default initial size for the ordering class. */</span>
<a name="l00035"></a>00035 <span class="keyword">const</span> <span class="keywordtype">int</span> init_ordering_size=4096;<span class="comment"></span>
<a name="l00036"></a>00036 <span class="comment">/** The initial size of the pre_container chunk index. */</span>
<a name="l00037"></a>00037 <span class="keyword">const</span> <span class="keywordtype">int</span> init_chunk_size=256;
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 <span class="comment">// If the initial memory is too small, the program dynamically allocates more.</span>
<a name="l00040"></a>00040 <span class="comment">// However, if the limits below are reached, then the program bails out.</span><span class="comment"></span>
<a name="l00041"></a>00041 <span class="comment">/** The maximum memory allocation for the number of vertices. */</span>
<a name="l00042"></a>00042 <span class="keyword">const</span> <span class="keywordtype">int</span> max_vertices=16777216;<span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment">/** The maximum memory allocation for the maximum vertex order. */</span>
<a name="l00044"></a>00044 <span class="keyword">const</span> <span class="keywordtype">int</span> max_vertex_order=2048;<span class="comment"></span>
<a name="l00045"></a>00045 <span class="comment">/** The maximum memory allocation for the any particular order of vertex. */</span>
<a name="l00046"></a>00046 <span class="keyword">const</span> <span class="keywordtype">int</span> max_n_vertices=16777216;<span class="comment"></span>
<a name="l00047"></a>00047 <span class="comment">/** The maximum buffer size for marginal cases used by the suretest class. */</span>
<a name="l00048"></a>00048 <span class="keyword">const</span> <span class="keywordtype">int</span> max_marginal=16777216;<span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment">/** The maximum size for the delete stack. */</span>
<a name="l00050"></a>00050 <span class="keyword">const</span> <span class="keywordtype">int</span> max_delete_size=16777216;<span class="comment"></span>
<a name="l00051"></a>00051 <span class="comment">/** The maximum size for the auxiliary delete stack. */</span>
<a name="l00052"></a>00052 <span class="keyword">const</span> <span class="keywordtype">int</span> max_delete2_size=16777216;<span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment">/** The maximum amount of particle memory allocated for a single region. */</span>
<a name="l00054"></a>00054 <span class="keyword">const</span> <span class="keywordtype">int</span> max_particle_memory=16777216;<span class="comment"></span>
<a name="l00055"></a>00055 <span class="comment">/** The maximum size for the wall pointer array. */</span>
<a name="l00056"></a>00056 <span class="keyword">const</span> <span class="keywordtype">int</span> max_wall_size=2048;<span class="comment"></span>
<a name="l00057"></a>00057 <span class="comment">/** The maximum size for the ordering class. */</span>
<a name="l00058"></a>00058 <span class="keyword">const</span> <span class="keywordtype">int</span> max_ordering_size=67108864;<span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment">/** The maximum size for the pre_container chunk index. */</span>
<a name="l00060"></a>00060 <span class="keyword">const</span> <span class="keywordtype">int</span> max_chunk_size=65536;
<a name="l00061"></a>00061 <span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment">/** The chunk size in the pre_container classes. */</span>
<a name="l00063"></a>00063 <span class="keyword">const</span> <span class="keywordtype">int</span> pre_container_chunk_size=1024;
<a name="l00064"></a>00064 
<a name="l00065"></a>00065 <span class="preprocessor">#ifndef VOROPP_VERBOSE</span>
<a name="l00066"></a>00066 <span class="preprocessor"></span><span class="comment">/** Voro++ can print a number of different status and debugging messages to</span>
<a name="l00067"></a>00067 <span class="comment"> * notify the user of special behavior, and this macro sets the amount which</span>
<a name="l00068"></a>00068 <span class="comment"> * are displayed. At level 0, no messages are printed. At level 1, messages</span>
<a name="l00069"></a>00069 <span class="comment"> * about unusual cases during cell construction are printed, such as when the</span>
<a name="l00070"></a>00070 <span class="comment"> * plane routine bails out due to floating point problems. At level 2, general</span>
<a name="l00071"></a>00071 <span class="comment"> * messages about memory expansion are printed. At level 3, technical details</span>
<a name="l00072"></a>00072 <span class="comment"> * about memory management are printed. */</span>
<a name="l00073"></a><a class="code" href="config_8hh.html#a692da825f7adf94704ec4bc7f8b6e388">00073</a> <span class="preprocessor">#define VOROPP_VERBOSE 0</span>
<a name="l00074"></a>00074 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00075"></a>00075 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00076"></a>00076 <span class="comment">/** If a point is within this distance of a cutting plane, then the code</span>
<a name="l00077"></a>00077 <span class="comment"> * assumes that point exactly lies on the plane. */</span>
<a name="l00078"></a>00078 <span class="keyword">const</span> <span class="keywordtype">double</span> tolerance=1e-11;
<a name="l00079"></a>00079 <span class="comment"></span>
<a name="l00080"></a>00080 <span class="comment">/** If a point is within this distance of a cutting plane, then the code stores</span>
<a name="l00081"></a>00081 <span class="comment"> * whether this point is inside, outside, or exactly on the cutting plane in</span>
<a name="l00082"></a>00082 <span class="comment"> * the marginal cases buffer, to prevent the test giving a different result on</span>
<a name="l00083"></a>00083 <span class="comment"> * a subsequent evaluation due to floating point rounding errors. */</span>
<a name="l00084"></a>00084 <span class="keyword">const</span> <span class="keywordtype">double</span> tolerance2=2e-11;
<a name="l00085"></a>00085 <span class="comment"></span>
<a name="l00086"></a>00086 <span class="comment">/** The square of the tolerance, used when deciding whether some squared</span>
<a name="l00087"></a>00087 <span class="comment"> * quantities are large enough to be used. */</span>
<a name="l00088"></a>00088 <span class="keyword">const</span> <span class="keywordtype">double</span> tolerance_sq=tolerance*tolerance;
<a name="l00089"></a>00089 <span class="comment"></span>
<a name="l00090"></a>00090 <span class="comment">/** A large number that is used in the computation. */</span>
<a name="l00091"></a>00091 <span class="keyword">const</span> <span class="keywordtype">double</span> large_number=1e30;
<a name="l00092"></a>00092 <span class="comment"></span>
<a name="l00093"></a>00093 <span class="comment">/** A radius to use as a placeholder when no other information is available. */</span>
<a name="l00094"></a>00094 <span class="keyword">const</span> <span class="keywordtype">double</span> default_radius=0.5;
<a name="l00095"></a>00095 <span class="comment"></span>
<a name="l00096"></a>00096 <span class="comment">/** The maximum number of shells of periodic images to test over. */</span>
<a name="l00097"></a>00097 <span class="keyword">const</span> <span class="keywordtype">int</span> max_unit_voro_shells=10;
<a name="l00098"></a>00098 <span class="comment"></span>
<a name="l00099"></a>00099 <span class="comment">/** A guess for the optimal number of particles per block, used to set up the</span>
<a name="l00100"></a>00100 <span class="comment"> * container grid. */</span>
<a name="l00101"></a>00101 <span class="keyword">const</span> <span class="keywordtype">double</span> optimal_particles=5.6;
<a name="l00102"></a>00102 <span class="comment"></span>
<a name="l00103"></a>00103 <span class="comment">/** If this is set to 1, then the code reports any instances of particles being</span>
<a name="l00104"></a>00104 <span class="comment"> * put outside of the container geometry. */</span>
<a name="l00105"></a><a class="code" href="config_8hh.html#a67fdb1741ce5fa942c0bea4d8d1322cb">00105</a> <span class="preprocessor">#define VOROPP_REPORT_OUT_OF_BOUNDS 0</span>
<a name="l00106"></a>00106 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment">/** Voro++ returns this status code if there is a file-related error, such as</span>
<a name="l00108"></a>00108 <span class="comment"> * not being able to open file. */</span>
<a name="l00109"></a><a class="code" href="config_8hh.html#a8de7f106cac2556a67bcc61bd364ed38">00109</a> <span class="preprocessor">#define VOROPP_FILE_ERROR 1</span>
<a name="l00110"></a>00110 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00111"></a>00111 <span class="comment">/** Voro++ returns this status code if there is a memory allocation error, if</span>
<a name="l00112"></a>00112 <span class="comment"> * one of the safe memory limits is exceeded. */</span>
<a name="l00113"></a><a class="code" href="config_8hh.html#a5dc0616f8a67ae3d1c2ba8a3dcf5612b">00113</a> <span class="preprocessor">#define VOROPP_MEMORY_ERROR 2</span>
<a name="l00114"></a>00114 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00115"></a>00115 <span class="comment">/** Voro++ returns this status code if there is any type of internal error, if</span>
<a name="l00116"></a>00116 <span class="comment"> * it detects that representation of the Voronoi cell is inconsistent. This</span>
<a name="l00117"></a>00117 <span class="comment"> * status code will generally indicate a bug, and the developer should be</span>
<a name="l00118"></a>00118 <span class="comment"> * contacted. */</span>
<a name="l00119"></a><a class="code" href="config_8hh.html#ad8e0de9d48da06e86dd87884e4a2d47e">00119</a> <span class="preprocessor">#define VOROPP_INTERNAL_ERROR 3</span>
<a name="l00120"></a>00120 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00121"></a>00121 <span class="comment">/** Voro++ returns this status code if it could not interpret the command line</span>
<a name="l00122"></a>00122 <span class="comment"> * arguments passed to the command line utility. */</span>
<a name="l00123"></a><a class="code" href="config_8hh.html#af88f7ba675d82866fea2342f26203384">00123</a> <span class="preprocessor">#define VOROPP_CMD_LINE_ERROR 4</span>
<a name="l00124"></a>00124 <span class="preprocessor"></span>
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126 
<a name="l00127"></a>00127 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>


<hr class="footer"/><address class="footer"><small>
Generated on Fri Sep 23 2011 22:49:06 for Voro++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.5.1
</small></address>

</body>
</html>
